Routines (alphabetical) > Routines: H > HDF-EOS Routines > EOS_GD_DEFDIM

EOS_GD_DEFDIM

This function defines dimensions that are used by the field definition routines (described subsequently) to establish the size of the field.

Syntax

Result = EOS_GD_DEFDIM(gridID, dimname, dim)

Return Value

Returns SUCCEED(0) if successful and FAIL(–1) otherwise.

Arguments

gridID

Grid id (long) returned by EOS_GD_CREATE or EOS_GD_ATTACH.

dimname

Name of dimension to be defined (string).

dim

The size of the dimension (long).

Keywords

None

Examples

In this example, we define a dimension, Band, with size 15:.

status = EOS_GD_DEFDIM(gridID, "Band", 15)

To specify an unlimited dimension that can be used to define an appendable array, the dimension value should be set to zero:

status = EOS_GD_DEFDIM(gridID, "Unlim", 0)

Version History

 

5.2

Introduced